Skip to content

Add an example to search for multi-byte pattern in an array #39479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,68 @@ browser.webRequest.onBeforeRequest.addListener(
);
```

This example demonstrates, how to search for multi-byte pattern in an array:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example is very large now. Should it be on https://github.com/mdn/webextensions-examples?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@def00111 yes, I think this is now getting to the point where we need to move it out of the documentation into a web extensions example.


```js
Object.defineProperty(Array.prototype, "indexOfMulti", {
value: function (searchElements, fromIndex) {
let i = this.indexOf(searchElements[0], fromIndex);
if (searchElements.length === 1 || i === -1) {
// Not found or no other elements to check
return i;
}

if (i + searchElements.length > this.length) {
return -1;
}

const initial = i;
for (let j = 1, l = searchElements.length; j < l; j++) {
if (this[++i] !== searchElements[j]) {
return this.indexOfMulti(searchElements, initial + 1);
}
}
return initial;
},
});
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Modifying built-in prototypes like this is generally considered an anti-pattern. It would be better to refactor this so indexOfMulti is a standalone function.

Suggested change
Object.defineProperty(Array.prototype, "indexOfMulti", {
value: function (searchElements, fromIndex) {
let i = this.indexOf(searchElements[0], fromIndex);
if (searchElements.length === 1 || i === -1) {
// Not found or no other elements to check
return i;
}
if (i + searchElements.length > this.length) {
return -1;
}
const initial = i;
for (let j = 1, l = searchElements.length; j < l; j++) {
if (this[++i] !== searchElements[j]) {
return this.indexOfMulti(searchElements, initial + 1);
}
}
return initial;
},
});
function indexOfMulti(arr, searchElements, fromIndex) {
let i = arr.indexOf(searchElements[0], fromIndex);
if (searchElements.length === 1 || i === -1) {
// Not found or no other elements to check
return i;
}
if (i + searchElements.length > arr.length) {
return -1;
}
const initial = i;
for (let j = 1, l = searchElements.length; j < l; j++) {
if (arr[++i] !== searchElements[j]) {
return indexOfMulti(arr, searchElements, initial + 1);
}
}
return initial;
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you'd like to improve this example, I'd suggest revising this function to use the KMP algorithm as this will reduce time spent on partial matches. That change isn't required for this PR, but if you don't want to make that change we should create a tracking issue to improve this in the future.


const encoder = new TextEncoder();
const elements = encoder.encode("WebExtension ");
const bytes = encoder.encode("Example");

function listener(details) {
const filter = browser.webRequest.filterResponseData(details.requestId);

const data = [];
filter.ondata = (event) => {
const buffer = new Uint8Array(event.data);
for (let i = 0, l = buffer.length; i < l; i++) {
data.push(buffer[i]);
}
};

filter.onstop = (event) => {
for (
let i = data.indexOfMulti(bytes), m = elements.length, n = bytes.length;
i >= 0;
i = data.indexOfMulti(bytes, i + m + n)
) {
// Insert "WebExtension " at the given index
data.splice(i, 0, ...elements);
}

filter.write(new Uint8Array(data));
filter.close();
};
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another suggestion that's out of scope for this PR: progressively apply the transform in ondata callbacks rather than buffering the entire file in memory and serially applying the transform at the end. This would improve scenarios where content can progressively render while streaming, such as with HTML responses.

}

browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/"], types: ["main_frame"] },
["blocking"],
);
```

{{WebExtExamples}}

## Browser compatibility
Expand Down